<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>[Generic Component Framework v3] GCF::MapToObjectEventBroadcaster Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<!--link href="tabs.css" rel="stylesheet" type="text/css"-->
</head><body>
 <div id="wrapper">
    <div id="logo_box">
        <a class="img_link" href="https://github.com/pnudupa/gcf" target="_blank" ><img style="float:left;margin-left:10px;margin-top:5px;margin-bottom:5px;"src="header_gcf_logo.jpg" alt="GCF LOGO"/></a>
        <a class="img_link" href="https://www.vcreatelogic.com/" target="_blank" ><img style="float:right;margin-right:10px; margin-top: 30px;" src="header_vcl_logo.jpg" alt="VCL LOGO"/></a>
        <div style="clear:both"></div>
    </div>
    <div class="nav">
        <ul>
            <li class="selectedpage">
                <a class="a-home" href="index.html" >
                    <span>Home</span>
                </a>
            </li>
            <li>
                <a class="a-classes " href="classes.html">
                    <span>All Classes</span>
                </a>
            </li>
            <li>
                <a class="a-home " href="gcf_modules.html">
                    <span>Modules</span>
                </a>
            </li>
            <li>
                <a class="a-home " href="gcf_guides_and_videos.html">
                    <span>Guides & Videos</span>
                </a>
            </li>
            <li>
                <a class="a-home " href="gcf_tools_and_inbuilt_components.html">
                    <span>Tools & Components</span>
                </a>
            </li>
        </ul>
    </div>
    <div id="main-content">
        <div class="inside">
        <div>
<!-- Generated by Doxygen 1.8.16 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>GCF</b></li><li class="navelem"><a class="el" href="class_g_c_f_1_1_map_to_object_event_broadcaster.html">MapToObjectEventBroadcaster</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_g_c_f_1_1_map_to_object_event_broadcaster-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">GCF::MapToObjectEventBroadcaster Class Reference<div class="ingroups"><a class="el" href="group__gcf__core.html">GCF Core Module</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="class_g_c_f_1_1_map_to_object_event_broadcaster.html" title="MapToObjectEventBroadcaster broadcasts inserted, removed and deleted events of MapToObject.">MapToObjectEventBroadcaster</a> broadcasts inserted, removed and deleted events of <a class="el" href="class_g_c_f_1_1_map_to_object.html">MapToObject</a>.  
 <a href="class_g_c_f_1_1_map_to_object_event_broadcaster.html#details">More...</a></p>

<p><code>#include &lt;GCF3/MapToObject&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ace1bd043ed837dc2fda755cc37d1e00e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_map_to_object_event_broadcaster.html#ace1bd043ed837dc2fda755cc37d1e00e">addListener</a> (<a class="el" href="class_g_c_f_1_1_map_to_object_event_listener.html">MapToObjectEventListener</a> *listener)</td></tr>
<tr class="separator:ace1bd043ed837dc2fda755cc37d1e00e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa761824f0c3af0bf1184cc3e5f5eca94"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_map_to_object_event_broadcaster.html#aa761824f0c3af0bf1184cc3e5f5eca94">removeListener</a> (<a class="el" href="class_g_c_f_1_1_map_to_object_event_listener.html">MapToObjectEventListener</a> *listener)</td></tr>
<tr class="separator:aa761824f0c3af0bf1184cc3e5f5eca94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8970def3cb04ce3ddb66e5c85240e08"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_map_to_object_event_broadcaster.html#aa8970def3cb04ce3ddb66e5c85240e08">removeAllListeners</a> ()</td></tr>
<tr class="separator:aa8970def3cb04ce3ddb66e5c85240e08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4099f5a59ad3a470ca9b607f9f5619ac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_g_c_f_1_1_map_to_object_event_listener.html">MapToObjectEventListener</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_map_to_object_event_broadcaster.html#a4099f5a59ad3a470ca9b607f9f5619ac">listenerAt</a> (int index) const</td></tr>
<tr class="separator:a4099f5a59ad3a470ca9b607f9f5619ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0e6bc0ffaa8e63be13b08c6c879e6e3"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_map_to_object_event_broadcaster.html#ab0e6bc0ffaa8e63be13b08c6c879e6e3">listenerType</a> () const</td></tr>
<tr class="separator:ab0e6bc0ffaa8e63be13b08c6c879e6e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed091842ff3216de667d150f58591b07"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_map_to_object_event_broadcaster.html#aed091842ff3216de667d150f58591b07">objectInserted</a> (QObject *obj)</td></tr>
<tr class="separator:aed091842ff3216de667d150f58591b07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f19e38159ff883ef708cd1fc65115f7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_map_to_object_event_broadcaster.html#a8f19e38159ff883ef708cd1fc65115f7">objectRemoved</a> (QObject *obj)</td></tr>
<tr class="separator:a8f19e38159ff883ef708cd1fc65115f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af95a0aa3baeaef4f644bd4985a651dc4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_map_to_object_event_broadcaster.html#af95a0aa3baeaef4f644bd4985a651dc4">objectDeleted</a> (QObject *obj)</td></tr>
<tr class="separator:af95a0aa3baeaef4f644bd4985a651dc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_g_c_f_1_1_map_to_object_event_listener"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_g_c_f_1_1_map_to_object_event_listener')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_g_c_f_1_1_map_to_object_event_listener.html">GCF::MapToObjectEventListener</a></td></tr>
<tr class="memitem:a373bc255c0e29b30c761594a16b2896e inherit pub_methods_class_g_c_f_1_1_map_to_object_event_listener"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_map_to_object_event_listener.html#a373bc255c0e29b30c761594a16b2896e">MapToObjectEventListener</a> ()</td></tr>
<tr class="separator:a373bc255c0e29b30c761594a16b2896e inherit pub_methods_class_g_c_f_1_1_map_to_object_event_listener"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17af9f470c02af5d6f15ff64fb29ee36 inherit pub_methods_class_g_c_f_1_1_map_to_object_event_listener"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_map_to_object_event_listener.html#a17af9f470c02af5d6f15ff64fb29ee36">~MapToObjectEventListener</a> ()</td></tr>
<tr class="separator:a17af9f470c02af5d6f15ff64fb29ee36 inherit pub_methods_class_g_c_f_1_1_map_to_object_event_listener"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="class_g_c_f_1_1_map_to_object_event_broadcaster.html" title="MapToObjectEventBroadcaster broadcasts inserted, removed and deleted events of MapToObject.">MapToObjectEventBroadcaster</a> broadcasts inserted, removed and deleted events of <a class="el" href="class_g_c_f_1_1_map_to_object.html">MapToObject</a> to all the <a class="el" href="class_g_c_f_1_1_map_to_object_event_listener.html">GCF::MapToObjectEventListener</a>'s added to it. You can add or remove a <a class="el" href="class_g_c_f_1_1_map_to_object_event_listener.html">GCF::MapToObjectEventListener</a> to this using <a class="el" href="class_g_c_f_1_1_map_to_object_event_broadcaster.html#ace1bd043ed837dc2fda755cc37d1e00e">addListener(MapToObjectEventListener *listener)</a>/ <a class="el" href="class_g_c_f_1_1_map_to_object_event_broadcaster.html#aa761824f0c3af0bf1184cc3e5f5eca94">removeListener(MapToObjectEventListener *listener)</a> functions.</p>
<p>This class inherits from <a class="el" href="class_g_c_f_1_1_map_to_object_event_listener.html" title="This listens to GCF::MapToObject&#39;s events.">GCF::MapToObjectEventListener</a>. To send notifications to GCF::MapToObjectEventListeners added to this; you first need to set event broadcast listener as <a class="el" href="class_g_c_f_1_1_map_to_object_event_listener.html">GCF::MapToObjectEventListener</a> of the <a class="el" href="class_g_c_f_1_1_map_to_object.html">GCF::MapToObject</a>. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ace1bd043ed837dc2fda755cc37d1e00e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace1bd043ed837dc2fda755cc37d1e00e">&#9670;&nbsp;</a></span>addListener()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GCF::MapToObjectEventBroadcaster::addListener </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_g_c_f_1_1_map_to_object_event_listener.html">MapToObjectEventListener</a> *&#160;</td>
          <td class="paramname"><em>listener</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Adds the <a class="el" href="class_g_c_f_1_1_map_to_object_event_listener.html">GCF::MapToObjectEventListener</a> to the broadcast list. After listener gets added, it will also get notifications for events on currently listening <a class="el" href="class_g_c_f_1_1_map_to_object.html">GCF::MapToObject</a>. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">listener</td><td><a class="el" href="class_g_c_f_1_1_map_to_object_event_listener.html">GCF::MapToObjectEventListener</a> that needs to be added to the broadcast list. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="aa761824f0c3af0bf1184cc3e5f5eca94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa761824f0c3af0bf1184cc3e5f5eca94">&#9670;&nbsp;</a></span>removeListener()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GCF::MapToObjectEventBroadcaster::removeListener </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_g_c_f_1_1_map_to_object_event_listener.html">MapToObjectEventListener</a> *&#160;</td>
          <td class="paramname"><em>listener</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Removes the <a class="el" href="class_g_c_f_1_1_map_to_object_event_listener.html">GCF::MapToObjectEventListener</a> from the broadcast list. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">listener</td><td><a class="el" href="class_g_c_f_1_1_map_to_object_event_listener.html">GCF::MapToObjectEventListener</a> that needs to be removed from the broadcast list. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="aa8970def3cb04ce3ddb66e5c85240e08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8970def3cb04ce3ddb66e5c85240e08">&#9670;&nbsp;</a></span>removeAllListeners()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GCF::MapToObjectEventBroadcaster::removeAllListeners </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Removes all MapToObjectEventListeners from the broadcast list. </p>

</div>
</div>
<a id="a4099f5a59ad3a470ca9b607f9f5619ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4099f5a59ad3a470ca9b607f9f5619ac">&#9670;&nbsp;</a></span>listenerAt()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GCF::MapToObjectEventBroadcaster::listenerAt </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>index</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Returns the <a class="el" href="class_g_c_f_1_1_map_to_object_event_listener.html">GCF::MapToObjectEventListener</a> at the specified index. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">index</td><td>index of which <a class="el" href="class_g_c_f_1_1_map_to_object_event_listener.html">GCF::MapToObjectEventListener</a> needs to be returned. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_g_c_f_1_1_map_to_object_event_listener.html">MapToObjectEventListener</a> at the specified index. </dd></dl>

</div>
</div>
<a id="ab0e6bc0ffaa8e63be13b08c6c879e6e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0e6bc0ffaa8e63be13b08c6c879e6e3">&#9670;&nbsp;</a></span>listenerType()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">GCF::MapToObjectEventBroadcaster::listenerType </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Returns the listener type of this class. Default listener type is "GCF::MapToObjectEventBroadcaster". </p><dl class="section return"><dt>Returns</dt><dd>listener type string. </dd></dl>

<p>Reimplemented from <a class="el" href="class_g_c_f_1_1_map_to_object_event_listener.html#a529780c711008064d9ef3c68d594131f">GCF::MapToObjectEventListener</a>.</p>

</div>
</div>
<a id="aed091842ff3216de667d150f58591b07"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed091842ff3216de667d150f58591b07">&#9670;&nbsp;</a></span>objectInserted()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void GCF::MapToObjectEventBroadcaster::objectInserted </td>
          <td>(</td>
          <td class="paramtype">QObject *&#160;</td>
          <td class="paramname"><em>obj</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>By default there is no implementation. This function will be called when a Value- <code>QObject</code> pointer pair is inserted into the listening <a class="el" href="class_g_c_f_1_1_map_to_object.html">GCF::MapToObject</a>. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">obj</td><td><code>QObject</code> pointer which was inserted into the listening ref <a class="el" href="class_g_c_f_1_1_map_to_object.html" title="This class manages a map of &lt;T&gt;-QObject pairs. &lt;T&gt; is a template class.">GCF::MapToObject</a>. </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented from <a class="el" href="class_g_c_f_1_1_map_to_object_event_listener.html#ae90a48048818ba50784240e97f2848c8">GCF::MapToObjectEventListener</a>.</p>

</div>
</div>
<a id="a8f19e38159ff883ef708cd1fc65115f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f19e38159ff883ef708cd1fc65115f7">&#9670;&nbsp;</a></span>objectRemoved()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void GCF::MapToObjectEventBroadcaster::objectRemoved </td>
          <td>(</td>
          <td class="paramtype">QObject *&#160;</td>
          <td class="paramname"><em>obj</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>By default there is no implementation. This function will be called when a Value- <code>QObject</code> pointer pair is removed from the listening <a class="el" href="class_g_c_f_1_1_map_to_object.html">GCF::MapToObject</a>. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">obj</td><td><code>QObject</code> pointer which was removed from the listening <a class="el" href="class_g_c_f_1_1_map_to_object.html">GCF::MapToObject</a>. </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented from <a class="el" href="class_g_c_f_1_1_map_to_object_event_listener.html#a58efaf21adcd2787ed3a7ddc73dd0915">GCF::MapToObjectEventListener</a>.</p>

</div>
</div>
<a id="af95a0aa3baeaef4f644bd4985a651dc4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af95a0aa3baeaef4f644bd4985a651dc4">&#9670;&nbsp;</a></span>objectDeleted()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void GCF::MapToObjectEventBroadcaster::objectDeleted </td>
          <td>(</td>
          <td class="paramtype">QObject *&#160;</td>
          <td class="paramname"><em>obj</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>By default there is no implementation. This function will be called when an <code>QObject</code> is in the listening <a class="el" href="class_g_c_f_1_1_map_to_object.html">GCF::MapToObject</a>. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">obj</td><td><code>QObject</code> pointer which was deleted. </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented from <a class="el" href="class_g_c_f_1_1_map_to_object_event_listener.html#a04c4026250bc7a80d4a8d744aa2966b2">GCF::MapToObjectEventListener</a>.</p>

</div>
</div>
</div><!-- contents -->
</div>
</div>
</div>
<div class="footer_content">
<table width="100%" class="footer">
<tr>
<td align="left" width="50%">Copyright &copy; 2013-2019,
 <a class="el" href="http://www.vcreatelogic.com" target="_black">VCreate Logic Private Limited</a></td>
<td align="right" width="50%"><a class="el" href="http://www.vcreatelogic.com/products/gcf" target="_black">GCF - Generic Component Framework</a></td>
</tr>
</table>
</div>
</div>
</body>
</html>
